Update docs #542
Merged
Update docs #542
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomasyu888
approved these changes
Dec 12, 2023
CONTRIBUTING.md
Outdated
|
|
||
| Follow this section when modifying the [Dockerfile](https://github.com/Sage-Bionetworks/Genie/blob/main/Dockerfile): | ||
|
|
||
| 1. Make sure you have your synapse config setup in your working directory |
There was a problem hiding this comment.
What is your rationale of doing this over using env variable to log into the python client?
There was a problem hiding this comment.
No rationale actually, I think I just carried this over from another project (specifying the env variable would be easier). Let me modify the docker command so it only has relevant flags in the command.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose: Just a small PR to update documentation to be consistent with the logic of the pipeline.
Changes Made
README.mdto include the up to date logic in running the pipeline steps (Note that there is a JIRA ticket to discuss the current logic here)CONTRIBUTING.mdto include section for running/testing docker, running pipeline steps on test pipeline